<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN">
<html>
<head>
<title>MapRule Element (Eclipse BIRT ROM Documentation)</title>
<link rel="stylesheet" href="../style/style.css" type="text/css"/>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</head>
<body>
<p class="title">Eclipse BIRT Report Object Model (ROM)</p>
<p class="subtitle">MapRule Structure</p>
<h1>Structure Overview</h1>
<div class="section-text">
Represents a map rule; each map rule  consists of a test expression, operator, values and corresponding
translated value</div>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Display Name:</td>
<td>MapRule</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
</table>

<h3>Property Summary</h3>

<dl class="section-text">
<dt><a href="#Property-display">display</a></dt>
<dd>The value to display when the map rule &quot;triggers.&quot;</dd>
<dt><a href="#Property-displayID">displayID</a></dt>
<dd>Resource key for the display value.</dd>
<dt><a href="#Property-isDesignTime">isDesignTime</a></dt>
<dd></dd>
<dt><a href="#Property-operator">operator</a></dt>
<dd>The operator for a simple condition</span></dd>
<dt><a href="#Property-testExpr">testExpr</a></dt>
<dd>An expression used to map internal values to display values</dd>
<dt><a href="#Property-value1">value1</a></dt>
<dd>The value for simple conditions with the operators: &lt;,
&lt;=, =, &lt;&gt;, &gt;=, &gt;, between, not between, like</dd>
<dt><a href="#Property-value2">value2</a></dt>
<dd>The value for simple conditions with the operators: between, not between</dd>
</dl>

<h3>Description</h3>

<div class="section-text">
<p>A map rule is part of the map rules. Each map rule contains a condition that
matches the value, and a value to display when the rule &quot;triggers.&quot; For
example, a set of map rules for a &quot;gender&quot; database column may map the
values null, M, F into the display values &quot;No data&quot;, &quot;Male&quot; and &quot;Female&quot;.</p></div>
<h1>Property Detail</h1>

<h2><a name="Property-display">display Property</a></h2>

<p class="section-text">The value to display when the map rule &quot;triggers.&quot;</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#string">string</a></td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Display</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>The display value appears when the map rule triggers. The value is a string and is
not further formatted</p></div>
<h3>See Also</h3>

<div class="section-text">
<p>&nbsp;</p></div>

<hr>
<h2><a name="Property-displayID">displayID Property</a></h2>

<p class="section-text">Resource key for the display value.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#resourceKey">resourceKey</a></td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>DisplayID</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
</table>

<h3>See Also</h3>

<div class="section-text">
<p>&nbsp;</p>

<p>&nbsp;</p></div>

<hr>
<h2><a name="Property-isDesignTime">isDesignTime Property</a></h2>

<p class="section-text"></p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#boolean">boolean</a></td></tr>
<tr><td>Since:</td>
<td>2.2</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Is Design Time</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>true</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
</table>


<hr>
<h2><a name="Property-operator">operator Property</a></h2>

<p class="section-text">The operator for a simple condition</span></p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#choice">choice</a> (mapOperator)</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Operator</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>eq</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
</table>

<h3>Choices</h3>

<table class="section-table">
<thead><tr><td>Name</td><td>Display Name</td>
<td>Value</td><td>Description</td></tr></thead>
<tbody>
<tr><td>eq</td>
<td>Equal to</td>
<td>eq</td>
<td></td></tr>
<tr><td>ne</td>
<td>Not Equal to</td>
<td>ne</td>
<td></td></tr>
<tr><td>lt</td>
<td>Less than</td>
<td>lt</td>
<td></td></tr>
<tr><td>le</td>
<td>Less than or Equal</td>
<td>le</td>
<td></td></tr>
<tr><td>ge</td>
<td>Greater than or Equal </td>
<td>ge</td>
<td></td></tr>
<tr><td>gt</td>
<td>Greater than</td>
<td>gt</td>
<td></td></tr>
<tr><td>between</td>
<td>Between</td>
<td>between</td>
<td></td></tr>
<tr><td>not-between</td>
<td>Not Between</td>
<td>not-between</td>
<td></td></tr>
<tr><td>is-null</td>
<td>Is Null</td>
<td>is-null</td>
<td></td></tr>
<tr><td>is-not-null</td>
<td>Is Not Null</td>
<td>is-not-null</td>
<td></td></tr>
<tr><td>is-true</td>
<td>Is True</td>
<td>is-true</td>
<td></td></tr>
<tr><td>is-false</td>
<td>Is False</td>
<td>is-false</td>
<td></td></tr>
<tr><td>like</td>
<td>Like</td>
<td>like</td>
<td></td></tr>
<tr><td>match</td>
<td>Match</td>
<td>match</td>
<td></td></tr>
<tr><td>top-n</td>
<td>Top n</td>
<td>top-n</td>
<td></td></tr>
<tr><td>bottom-n</td>
<td>Bottom n</td>
<td>bottom-n</td>
<td></td></tr>
<tr><td>top-percent</td>
<td>Top percent</td>
<td>top-percent</td>
<td></td></tr>
<tr><td>bottom-percent</td>
<td>Bottom percent</td>
<td>bottom-percent</td>
<td></td></tr>
<tr><td>not-like</td>
<td>Not Like</td>
<td>not-like</td>
<td></td></tr>
<tr><td>not-match</td>
<td>Not Match</td>
<td>not-match</td>
<td></td></tr>
<tr><td>not-in</td>
<td>Not In</td>
<td>not-in</td>
<td></td></tr>
<tr><td>in</td>
<td>In</td>
<td>in</td>
<td></td></tr>
</tbody></table><br>
<h3>See Also</h3>

<div class="section-text">
<p>&nbsp;</p></div>

<hr>
<h2><a name="Property-testExpr">testExpr Property</a></h2>

<p class="section-text">An expression used to map internal values to display values</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#expression">expression</a></td></tr>
<tr><td>Context:</td>
<td></td></tr>
<tr><td>Expression Type:</td>
<td>any</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>TestExpression</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
</table>

<h3>See Also</h3>

<div class="section-text">
<p>&nbsp;</p></div>

<hr>
<h2><a name="Property-value1">value1 Property</a></h2>

<p class="section-text">The value for simple conditions with the operators: &lt;,
&lt;=, =, &lt;&gt;, &gt;=, &gt;, between, not between, like</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#list">list</a></td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Value1</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
</table>

<h3>See Also</h3>

<div class="section-text">
<p>&nbsp;</p></div>

<hr>
<h2><a name="Property-value2">value2 Property</a></h2>

<p class="section-text">The value for simple conditions with the operators: between, not between</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#expression">expression</a></td></tr>
<tr><td>Context:</td>
<td></td></tr>
<tr><td>Expression Type:</td>
<td>any</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Value2</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
</table>

<h3>See Also</h3>

<div class="section-text">
<p>&nbsp;</p></div>
</body>
</html>
